Inside Macintosh: QuickDraw GX Graphics /

Chapter 3 - Geometric Styles / Geometric Styles Reference

Functions / Getting and Setting Dashes

GXSetShapeDash

You can use the GXSetShapeDash function to change the dash information for a style object associated with a particular shape.

void GXSetShapeDash(gxShape target, const gxDashRecord *dash);

target

A reference to the shape whose dash information you want to change.

dash

A pointer to the new dash information.

DESCRIPTION

The GXSetShapeDash function replaces the dash information in the style object of the shape specified by the target parameter with the dash information provided by the dash parameter. You use the gxDashRecord structure to provide dash information.

Passing nil for the dash parameter indicates that you want no dashing to occur and QuickDraw GX removes any dash information from the target shape.

If the target shape shares its style object with other shapes, this function makes a copy of the style object, sets the target shape to reference the copy, and changes the dash property of the copy. (However, if the effect of this function would leave the dash information unchanged, this function does not create a copy of the style object; instead, it returns a notice.)

ERRORS, WARNINGS, AND NOTICES

Errors
out_of_memory
style_is_nil
parameter_out_of_range	(debugging version)
empty_shape_not_allowed	(debugging version)
ignorePlatformShape_not_allowed	(debugging version)
illegal_type_for_shape	(debugging version)
nil_style_in_glyph_not_allowed	(debugging version)
complex_glyph_style_not_allowed	(debugging version)
shapeFill_not_allowed	(debugging version)
Warnings
graphic_type_cannot_be_dashed
Notices (debugging version)
dash_already_set
tags_in_shape_ignored

SEE ALSO

For a discussion of dashes, see "Dashes" on page 3-27.

For examples of adding dashes to shapes, see page 3-66 through page 3-86.

For a discussion of the gxDashRecord structure and a description of what types of shapes you can use as dash shapes, see "The Dash Structure" on page 3-103.

To retrieve dash information from a style object, use the GXGetStyleDash function, which is described on page 3-135.

To specify dash information for a style object, use the GXSetStyleDash function, which is described on page 3-136.

To retrieve dash information from a style object associated with a particular shape, use the GXGetShapeDash function, which is described on page 3-138.

To determine where dashing occurs for a particular shape, use the GXGetShapeDashPositions function, which is described in the next section.

Main | Page One | What's New | Apple Computer, Inc. | Find It | Contact Us | Help